home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / xdiff.z / xdiff
Text File  |  1998-10-20  |  19KB  |  529 lines
  1.  
  2.  
  3.  
  4. XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))                                                            XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      xdiff - X11/Motif based file comparator and merge tool.
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      xxxxddddiiiiffffffff [-Dwib] [-N stdin name] path1 path2
  13.  
  14. OOOOVVVVEEEERRRRVVVVIIIIEEEEWWWW
  15.      xxxxddddiiiiffffffff is a graphical browser for viewing the differences between two
  16.      files and can be used to produce a merged version.  The text of the two
  17.      files are presented side by side with their differences highlighted for
  18.      easy identification.
  19.  
  20.      The two paths supplied on the command line identify the files to be
  21.      compared.  One of the two paths must be a file.  The other may be one of
  22.      three things.  Another file, a directory, in which case the last
  23.      component of the file name will be appended to the directory to form the
  24.      other file name, or a '-', in which case the input for that path will be
  25.      read from standard input.
  26.  
  27. OOOOPPPPTTTTIIIIOOOONNNNSSSS FFFFOOOORRRR XXXXDDDDIIIIFFFFFFFF
  28.      -N   When input is read from stdin this option specifies the string to
  29.           use in place of it's name in the title bar.  If not specified the
  30.           string "<stdin>" is used.
  31.  
  32.      -D   If there are no differences then exit quietly with exit code of 0.
  33.  
  34.      -w   Passed on to diff(1). Ignore whitespace when comparing the two
  35.           files.
  36.  
  37.      -b   Passed on to diff(1). Ignore trailing blanks when comparing the two
  38.           files.
  39.  
  40.      -i   Passed on to diff(1). Ignore case when comparing the two files.
  41.  
  42.      -    Not really an option. Use stdin as one of the files. See above.
  43.  
  44. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  45.      The xdiff window is divided into 4 main areas. These are, the menu bar at
  46.      the top of the window, a message line just below it, an overview area on
  47.      the right side of the window and a text area occupying the remainder. The
  48.      text area is further divided into two text windows, one for each file, a
  49.      vertical slider between them and a horizontal slider underneath each text
  50.      area.
  51.  
  52. TTTTEEEEXXXXTTTT WWWWIIIINNNNDDDDOOOOWWWWSSSS
  53.      xxxxddddiiiiffffffff uses diff(1) to determine the differences between the two files.
  54.      The text of the two files is displayed in two scrollable windows in the
  55.      main area of the window. Differences are highlighted using different
  56.      colours for the foreground and background. These may be specified by the
  57.      user as described below in the section on user preferences.  A vertical
  58.      slider separates the two text areas and controls the vertical positioning
  59.      of both text areas simultaneously.  The size of the thumb of the slider
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))                                                            XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))
  71.  
  72.  
  73.  
  74.      is scalled to represent the amount of text visible in the windows.
  75.  
  76.      xxxxddddiiiiffffffff can be used to merge the differences from the two files into third.
  77.      To select the desired differences the user interacts as follows. To write
  78.      this merged version see the section of the File menu.
  79.  
  80.      With the pointer in the left window and pressing the left button the
  81.      cursor line moves to the line under the pointer. If this line is in a
  82.      difference region then the the left region is selected. Similarly the
  83.      differences in the right window may be selected by pressing the left
  84.      button on the difference in the right window.
  85.  
  86.      Pressing the middle button with the pointer in either the left or right
  87.      windows will move the cursor line to the line under the pointer. If this
  88.      is within a difference region then a selection of only the cursor line is
  89.      made.  This allows a finer level of selection of which text will appear
  90.      in the merged output.
  91.  
  92.      Holding the Shift key will cause the region or line, as described above,
  93.      to have it's selection removed.
  94.  
  95.      Pressing the right button while in either the left or right windows will
  96.      post a popup menu.  This popup's methods are to move to other difference
  97.      regions. Accelerators may be attached to provide quick navigation using
  98.      the keyboard.
  99.  
  100.      Next Difference
  101.           Go to the first line of the next difference region.
  102.  
  103.      Previous Difference
  104.           Go to the last line of the previous difference region.
  105.  
  106.      Next Unselected
  107.           Go the the first line of the next difference region that is still
  108.           unselected.
  109.  
  110.      Previous Unselected
  111.           Go the the last line of the previous difference region that is still
  112.           unselected.
  113.  
  114. OOOOVVVVEEEERRRRVVVVIIIIEEEEWWWW WWWWIIIINNNNDDDDOOOOWWWW
  115.      The overview window appears at the right side of the xdiff window. It's
  116.      purpose is to show graphically the number, location and size of the
  117.      differences between the two files.  This display consists of two columns
  118.      representing the files and their differences and an area in between where
  119.      lines indicate where the differences occur with respect to the other
  120.      file.  A small arrow is shown in each column and represents the position
  121.      of the cursor line in that file.  The relative lengths of the files are
  122.      shown by comparing the lengths of the two columns.
  123.  
  124.      Pressing any button while the pointer is in the overview area will move
  125.      the cursor line to the position in the file indicated by the pointer
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))                                                            XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))
  137.  
  138.  
  139.  
  140.      position.  If the pointer is in the left half of the overview window the
  141.      line will be determined from the left file and from the right file if the
  142.      pointer is in the right half.  The cursor line will then be displayed in
  143.      the center of the text windows.
  144.  
  145. MMMMEEEENNNNUUUU BBBBAAAARRRR
  146.      xxxxddddiiiiffffffff has a menu bar consisting of six buttons. These are listed below
  147.      and described in more detail in the sections that follow.
  148.  
  149.      File
  150.           Contains output commands and exit.
  151.  
  152.      Edit
  153.           Contains searching and cursor movement functions.
  154.  
  155.      Global
  156.           Contains functions that apply to the entire file.
  157.  
  158.      Region
  159.           Contains functions that apply to a single difference region.
  160.  
  161.      Line
  162.           Contains functions that apply to a single difference line.
  163.  
  164.      Help
  165.           Interface to access the online help.
  166.  
  167. FFFFiiiilllleeee MMMMeeeennnnuuuu
  168.      This menu is used to save the merged text to a file and to exit xdiff.
  169.      Before a save can be performed all differenced must have a selection.  If
  170.      not, an error message is displayed in the message line and the cursor
  171.      line is moved to the first line which does not have a selection.  After a
  172.      save to a file, a message will be displayed in the message line to
  173.      indicate the status of the save. If the resource confirmWrite is set to
  174.      True then a confirmation dialog is presented before a save allowing the
  175.      user to confirm the write or cancel the operation. The default for the
  176.      confirmWrite resource is True.
  177.  
  178.      If you attempt to save to the left file or the right file when that file
  179.      has been read from the standard input xdiff will write the output to
  180.      standard output.  This allows xdiff to be used in a filter chain like all
  181.      well behaved Unix utilities.
  182.  
  183.      Save as Right
  184.           Short cut to save the merged text to the file on the right.
  185.  
  186.      Save as Left
  187.           Short cut to save the merged text to the file on the left.
  188.  
  189.      Save As ...
  190.           Save As will present the user with the Motif file selection box. If
  191.           the user presses the OK button then the merged text will be written
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))                                                            XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))
  203.  
  204.  
  205.  
  206.           to the specified file subject to the confirmation described above.
  207.  
  208.           When writing the regions of common text using Save As the text from
  209.           the left file is used. This may yeild surprises if the -w -b -i
  210.           flags are used. Although the text is indicated as being the same it
  211.           may not be.
  212.  
  213.      Exit
  214.           Leave xdiff unconditionally.
  215.  
  216. EEEEddddiiiitttt MMMMeeeennnnuuuu
  217.      This menu contains functions for search and cursor movement.
  218.  
  219.      Search ...
  220.           Search will present a dialog box containing an editable text feild
  221.           and a Search and Cancel button.  The user may enter a regular
  222.           expression in the text feild to specify the search pattern.
  223.           Pressing Enter or pressing the Search button will initiate the
  224.           search on all text in both files. A small diamond will appear in the
  225.           overview area for each line that matches the search pattern. To move
  226.           to a match you may click on one of the diamonds in the overview area
  227.           or use the Search Next or Search Previous buttons from this menu.
  228.  
  229.      Search Next
  230.           Move the cursor from its current position to the next match from
  231.           either file.  If there are no more matches then it the cursor is
  232.           positioned at the bottom.
  233.  
  234.      Search Previous
  235.           Move the cursor from its current position to the previous match from
  236.           either file.  If there are no more matches then it the cursor is
  237.           positioned at the top.
  238.  
  239.      Scroll Down
  240.           The cursor line is moved down half the number of visible lines and
  241.           then that line is centered in the window if possible. The
  242.           functionality of this and the following buttons in this menu are
  243.           really not required since it can all be done using the scroll bars.
  244.           They are included so that accelerators may be added. In this way the
  245.           operation of xdiff can be completely controlled from the keyboard.
  246.  
  247.      Scroll Up
  248.           The cursor line is moved up half the number of visible lines and
  249.           then that line is centered in the window if possible.
  250.  
  251.      Cursor Down
  252.           The cursor line is moved to the next line. That line is the centered
  253.           in the window if possible. This gives the effect of the text
  254.           scrolling under a stationary cursor.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))                                                            XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))
  269.  
  270.  
  271.  
  272.      Cursor Up
  273.           The cursor line moves as above but in the other direction.
  274.  
  275.      Cursor Top
  276.           The cursor line is set to the first line. That  line is displayed at
  277.           the top of the window.
  278.  
  279.      Cursor Bottom
  280.           The cursor line is set to the last line. That line is displayed at
  281.           the bottom of the window of possible.
  282.  
  283.      Redo Diff
  284.           The files are diff'd again.  Any selection information is lost.  The
  285.           intention is that you can hand-edit one of the files and then re-
  286.           diff.  This can provide a major improvement in ease of merging
  287.           files.
  288.  
  289. GGGGlllloooobbbbaaaallll MMMMeeeennnnuuuu
  290.      This menu contains operation that affect the entire file.
  291.  
  292.      Select Left
  293.           Selects all the difference regions from the left file.
  294.  
  295.      Select Right
  296.           Selects all the difference regions from the right file.
  297.  
  298.      Select Neither
  299.           All regions from both files are unselected. Only common text will be
  300.           included in the merged output.
  301.  
  302.      Unselect
  303.           Removes all selections that have been made.
  304.  
  305.      Tabs 4
  306.           Specifies that tabs should be expanded to 4 spaces.
  307.  
  308.      Tabs 8
  309.           Specifies that tabs should be expanded to 8 spaces.
  310.  
  311.      Line Numbers
  312.           Each line of text will be prefixed with the line number from its
  313.           file.  Regions of absent text will not have a line number.
  314.  
  315. RRRReeeeggggiiiioooonnnn MMMMeeeennnnuuuu
  316.      The functions of the Region Menu use the location of the cursor line to
  317.      specify the region for which the function is to be performed.  These
  318.      functions will only work when the cursor line is on a difference.
  319.  
  320.      Select Right
  321.           The entire difference region from the right file is selected.
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))                                                            XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))
  335.  
  336.  
  337.  
  338.      Select Left
  339.           The entire difference region from the left file is selected.
  340.  
  341.      Select Neither
  342.           Both the left and the right regions are unselected. Neither region
  343.           will be included in the merged output.
  344.  
  345.      Unselect
  346.           Any previous selection made to this region will be removed.
  347.  
  348.      Split Right
  349.           In the case when the text has changed between the left and the right
  350.           files and it is desired to have both differences appear in the
  351.           merged output split right can be used to create two differences so
  352.           that each can then be selected individually.  Split right will list
  353.           the text from the right file first and then the text from the left
  354.           file. Any selection that has been previously made to the region will
  355.           be applied to both regions after the split.
  356.  
  357.      Split Left
  358.           Same as Split Right except that the text from the left file is
  359.           listed first.
  360.  
  361. LLLLiiiinnnneeee MMMMeeeennnnuuuu
  362.      This menu's functions use the location of the cursor line to specify the
  363.      line for which the operation is to be performed.  These functions will
  364.      only work when the cursor line is on a difference.
  365.  
  366.      Select Right
  367.           Only the cursor line is selected from the right file.
  368.  
  369.      Select Left
  370.           Only the cursor line is selected from the left file.
  371.  
  372.      Select Neither
  373.           The cursor line for both sides are unselected and so neither line
  374.           will be included in the merged output.
  375.  
  376.      Unselect
  377.           Any previous selection made to this line will be removed.
  378.  
  379. HHHHeeeellllpppp MMMMeeeennnnuuuu
  380.      On Context
  381.           To obtain help for any widget in the main window. Selecting the help
  382.           on context button will cause the cursor to change to a question
  383.           mark.  Move this cursor to any of the widgets and click. A help
  384.           window will appear to describe the widget and it interactions.
  385.  
  386.      About xdiff
  387.           Provides general information about xdiff.
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))                                                            XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))
  401.  
  402.  
  403.  
  404. UUUUSSSSEEEERRRR PPPPRRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEESSSS
  405.      The differences obtained from diff(1) can be clasified into 4 types.
  406.  
  407.      Common
  408.           Common Text which is present in both files.
  409.  
  410.      Only
  411.           Only text is text that appears only in one file.
  412.  
  413.      Absent
  414.           When text is missing from a file the void is called Absent. This
  415.           always accompanies Only text.
  416.  
  417.      Changed
  418.           Text which has been changed between the files is called Changed
  419.           Text.
  420.  
  421.  
  422.      Unselected text will use the types above. Once a selection has been made
  423.      the following types will apply.
  424.  
  425.      Selected
  426.           When the user has selected one of the two sides of a difference then
  427.           that will be selected the other side  will become deleted.
  428.  
  429.      Deleted
  430.           This text is not desired in the merged output.
  431.  
  432.  
  433.      These names are used to form X11 resources names to determine the users
  434.      preferences.
  435.  
  436.      Each of these categories may have different colours for foreground and
  437.      background. They may also have a different font.  Any unspecified fonts
  438.      will default to the font for fontCommon.  To specify the foreground
  439.      resources name prefix the name with 'fgc' the background is specified by
  440.      prefixing the name with 'bgc'. To specify the font, prefix with 'font'.
  441.      From the app-defaults file the Common text is specified with.
  442.  
  443.      *fontCommon:    *-clean-medium-r-normal-*-14-*
  444.      *fgcCommon:     black
  445.      *bgcCommon:     grey
  446.      The cursor colour may be specified using the resource 'cursorColour' This
  447.      colour is used to outline the current line in the text windows and the
  448.      outline of the trianglular indicator in the overview area.  Lines that
  449.      match the pattern specified in the search window may be outlined in a
  450.      different colour to indicate the match.  The resource used to specify
  451.      this is 'matchColour' if not specified the cursorColour is used.
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                                                                         PPPPaaaaggggeeee 7777
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466. XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))                                                            XXXXDDDDIIIIFFFFFFFF((((1111LLLL))))
  467.  
  468.  
  469.  
  470. FFFFIIIILLLLEEEESSSS
  471.      xxxxddddiiiiffffffff uses a temporary file when reading from stdin. This file will be
  472.      located in $TMPDIR if it is defined otherwise it will be located in
  473.      /usr/tmp.  The file name will be of the form xdiffXXXXXX.
  474.  
  475.      Application defaults for xdiff can be found in /usr/lib/X11/app-
  476.      defaults/Xdiff.
  477.  
  478. NNNNOOOOTTTTEEEESSSS
  479.      The default accelerator keys used by xdiff have changed from the original
  480.      gdiff accelerators to be consistent with those used in other SGI desktop
  481.      applications.
  482.  
  483. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  484.      gdiff(1), diff(1).
  485.  
  486. AAAAUUUUTTTTHHHHOOOORRRR
  487.      Rudy Wortel <rudy@alias.com>.
  488.      Inspired by gdiff written by Andrew C. Myers.
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.                                                                         PPPPaaaaggggeeee 8888
  526.  
  527.  
  528.  
  529.